Skip to content

Release Python SDK 2.20.0: signal-with-start and durable signal-external - #349

Merged
rmcdaniel merged 2 commits into
mainfrom
release/sdk-python-2.20.0
Nov 19, 2026
Merged

rmcdaniel merged 2 commits into
mainfrom
release/sdk-python-2.20.0

Conversation

@rmcdaniel

Copy link
Copy Markdown
Member

Prepares the Python SDK 2.20.0 release from current main (c593df85, which includes #347 and #346). Not tagged or published. Open #348 is not included.

What ships (since 2.19.1)

Package changes since 2.19.1 are #347 and #346. Both add public API with no breaking change, so this is a minor release.

Server requirement

Both need native Server 3.15.0 or later, the first Server that advertises capabilities.signal_with_start and the signal_external_workflow worker command. Each call is capability-gated and refused before anything is sent on an older Server (RuntimeCapabilityUnsupported, or the workflow task fails with signal_external_workflow_unavailable). Every other feature keeps working on older Servers, and worker protocol (1.20) and control-plane (2) are unchanged in Server 3.15.0, so the SDK-wide supported-server-versions / supported-server-release-baselines stay as they are. The requirement is documented in the CHANGELOG, docs/sdk-reference.md (new Signal-with-start section and a feature/Server table under Compatibility) and docs/reference/workflow.md.

Release metadata

Version metadata 2.20.0, CHANGELOG section [2.20.0] - 2026-11-19, and the installed retry-cap cell retargeted to the 2.20.0 candidate on native Server 3.15.0 (index sha256:f7f84884… in ghcr.io/durable-workflow/server and durableworkflow/server, source fdb6c4f6, amd64 sha256:0d0db083…).

Remaining steps (same as 2.19.x, #342/#345)

  1. Build-only candidate run of this head, then review its exact wheel and sdist.
  2. Commit only .github/release-candidates/2.20.0.json.
  3. Candidate ci.yml run with activity_retry_cap=true, retry_cap_artifact_source=candidate.
  4. Merge with a merge commit at the reviewed head (--match-head-commit).
  5. Annotated tag 2.20.0, which triggers publish.yml. Then verify PyPI and run the registry ci.yml repeat on main.

🤖 Generated with Claude Code

Ships signal-with-start (#347, .github#222) and durable signal-external
(#346, .github#223). Both need native Server 3.15.0 or later; they are
capability-gated, so the supported Server baselines stay unchanged and
the requirement is documented in the CHANGELOG and docs.

Retargets the installed retry-cap qualification cell to the 2.20.0
candidate on native Server 3.15.0 (index sha256:f7f84884..., source
fdb6c4f6, amd64 sha256:0d0db083...).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Records build-only run 44583674899 (attempt 1) at d5e6e63: its
dist-handoff.tar artifact and the exact wheel and sdist reviewed
against the source and qualified on native Server 3.15.0.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@rmcdaniel

Copy link
Copy Markdown
Member Author

Candidate review. Build-only run 44583674899 (attempt 1) built head d5e6e63a. Its dist-handoff.tar artifact 14559796844 has SHA-256 18620e7c… (equal to the API digest; expires 2027-02-17).

  • wheel e97aae2f3895165dd97817f0abc29ead23d48b81e228d3fa7491ef01cc293989: 53 members, every non-dist-info file byte-identical to src/ at d5e6e63a, same file set as the published 2.19.1 wheel. Changed modules vs 2.19.1: __init__, client, errors, sync, worker, workflow (exactly Let workflow code signal another workflow durably #346/Add Client.signal_with_start for atomic intake (.github#222) #347). METADATA Version: 2.20.0.
  • sdist 50e9c0ddc840f4af6fe8de759f761a5d5108dc83fcfc793075b57ca09123e8c7: every tracked file byte-identical to Git at d5e6e63a; only generated PKG-INFO, setup.cfg and egg-info are untracked.

Qualified on native Server 3.15.0 (ghcr.io/durable-workflow/server@sha256:f7f84884…, revision label fdb6c4f6; capped local containers, sqlite) with this exact wheel installed in Python 3.12:

  • /api/cluster/info advertises capabilities.signal_with_start and signal_external_workflow (protocol 1.20).
  • signal_with_start: started_new, same-key retry returns the original command, open run reused (returned_existing_active), closed run refused run_not_active, closed_run_policy="start_new_run" starts a new run, duplicate_policy="fail" refused instance_already_started.
  • tests/integration/test_signal_external_workflow.py + test_smoke.py: 7 passed, 1 skipped (the gate scenario needs a Server without the capability).
  • On Server 3.14.0 the same wheel gates both: signal_with_start raises RuntimeCapabilityUnsupported, and the signal-external gate test passes, while ordinary starts still work. So the SDK-wide Server baselines stay unchanged; the 3.15.0 requirement is per-feature and documented.

6bf7cf46 adds only .github/release-candidates/2.20.0.json. Next is the candidate retry-cap cell on Server 3.15.0.

🤖 Generated with Claude Code

@sonarqubecloud

Copy link
Copy Markdown

@rmcdaniel
rmcdaniel merged commit 95f35d5 into main Nov 19, 2026
42 checks passed
@rmcdaniel

Copy link
Copy Markdown
Member Author

Published.

  • Candidate qualification at 6bf7cf46, run 44584968512: every cell passed, including activity-retry-cap on the candidate on native Server 3.15.0.
  • Merged at 6bf7cf46 → merge commit 95f35d53 (tree identical to the reviewed head). Annotated tag 2.20.0 → 95f35d53. publish.yml 44586500907 passed build, publish, verify and github-release.
  • PyPI: wheel e97aae2f… and sdist 50e9c0dd…, both equal to the approval. A clean Python 3.12 venv installs 2.20.0 and exposes Client.signal_with_start, WorkflowContext.signal_external_workflow, SignalWithStartFailed and InvalidSignalName.
  • Registry repeat 44586852461: attempt 1's activity-retry-cap failed in pip download because the PyPI simple index did not list 2.20.0 yet (dispatched a minute after upload). After the index was updated, attempt 2 re-ran it and it passed. The run is green.

🤖 Generated with Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant